Skip to content

UploadMediaProps

Properties for defining a UploadMedia.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ice-uploadmedia

Initializer 

import ros_cdk_ice
ros_cdk_ice.UploadMediaProps(
  app_id: typing.Union[str, IResolvable] = None,
  entity_id: typing.Union[str, IResolvable] = None,
  file_info: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  media_meta_data: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  post_process_config: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  upload_target_config: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  user_data: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None
)

Properties

Name Type Description
app_id typing.Union[str, ros_cdk_core.IResolvable] Property appId: The application ID.
entity_id typing.Union[str, ros_cdk_core.IResolvable] Property entityId: The entity ID.
file_info typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property fileInfo: The file information, which is in the JSON format and contains the following fields: Type: required.
media_meta_data typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property mediaMetaData: The metadata of the media asset, which is a JSON string that contains the following fields: Title: required.
post_process_config typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property postProcessConfig: Type = video || audio There is a post-upload processing action.
upload_target_config typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property uploadTargetConfig: The destination storage address.
user_data typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property userData: The user data.

app_idOptional 

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

Property appId: The application ID.

Default value: app-1000000.

entity_idOptional 

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

Property entityId: The entity ID.

You can call the CreateEntity operation to create an entity and specify a dynamic metadata structure.

file_infoOptional 

file_info: typing.Union[IResolvable, typing.Mapping[typing.Any]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property fileInfo: The file information, which is in the JSON format and contains the following fields: Type: required.

The file type. Valid values: video, image, audio, text, and other. Name: required. The file name without the extension. Size: optional. The file size. Ext: required. The file name extension.

media_meta_dataOptional 

media_meta_data: typing.Union[IResolvable, typing.Mapping[typing.Any]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property mediaMetaData: The metadata of the media asset, which is a JSON string that contains the following fields: Title: required.

The value can be up to 128 characters in length. The value must be encoded in UTF-8. Description: optional. The value can be up to 1,024 characters in length. The value must be encoded in UTF-8. CateId: optional. Tags: optional. BusinessType: required. Valid values: opening or ending if Type is set to video default or cover if Type is set to image subtitles or font if Type is set to text watermark if Type is set to material general CoverURL: optional. DynamicMetaData: The value is a string.

post_process_configOptional 

post_process_config: typing.Union[IResolvable, typing.Mapping[typing.Any]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property postProcessConfig: Type = video || audio There is a post-upload processing action.

ProcessType Value: Workflow.

upload_target_configOptional 

upload_target_config: typing.Union[IResolvable, typing.Mapping[typing.Any]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property uploadTargetConfig: The destination storage address.

Set StorageType to oss. Set StorageLocation to an address in ApsaraVideo VOD. You cannot set this field to an OSS URL.

user_dataOptional 

user_data: typing.Union[IResolvable, typing.Mapping[typing.Any]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property userData: The user data.

The value must be a JSON string. You can configure settings such as message callbacks.