Skip to content

UploadMedia

This class encapsulates and extends the ROS resource type ALIYUN::ICE::UploadMedia.

Initializers 

import ros_cdk_ice
ros_cdk_ice.UploadMedia(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No 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.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

app_idOptional

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

Property appId: The application ID.

Default value: app-1000000.

entity_idOptional

  • 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

  • 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

  • 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

  • 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

  • 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

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

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_ice
ros_cdk_ice.UploadMedia.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_file_url ros_cdk_core.IResolvable Attribute FileURL: The OSS URL of the file.
attr_media_id ros_cdk_core.IResolvable Attribute MediaId: The ID of the media asset.
attr_media_url ros_cdk_core.IResolvable Attribute MediaURL: The URL of the media asset.
attr_upload_address ros_cdk_core.IResolvable Attribute UploadAddress: The upload URL.
attr_upload_auth ros_cdk_core.IResolvable Attribute UploadAuth: The upload credential.

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_file_urlRequired 

attr_file_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute FileURL: The OSS URL of the file.

The URL does not contain the information used for authentication.

attr_media_idRequired 

attr_media_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MediaId: The ID of the media asset.

attr_media_urlRequired 

attr_media_url: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MediaURL: The URL of the media asset.

Note If a domain name for Alibaba Cloud CDN (CDN) is specified, a CDN URL is returned. Otherwise, an OSS URL is returned. If the HTTP status code 403 is returned when you access the URL from your browser, the URL authentication feature of ApsaraVideo VOD is enabled. To resolve this issue, disable URL authentication or generate an authentication signature.

attr_upload_addressRequired 

attr_upload_address: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UploadAddress: The upload URL.

Note The returned upload URL is a Base64-encoded URL. You must decode the Base64-encoded upload URL before you use an SDK or call an API operation to upload media files. You need to parse UploadAddress only if you use OSS SDK or call an OSS API operation to upload media files.

attr_upload_authRequired 

attr_upload_auth: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute UploadAuth: The upload credential.

Note The returned upload credential is a Base64-encoded value. You must decode the Base64-encoded upload URL before you use an SDK or call an API operation to upload media files. You need to parse UploadAuth only if you use OSS SDK or call an OSS API operation to upload media files.

Structs