UploadMedia

• Implements: IUploadMedia

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

Initializers

import com.aliyun.ros.cdk.ice.UploadMedia;
UploadMedia.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .appId(java.lang.String)
//  .appId(IResolvable)
//  .entityId(java.lang.String)
//  .entityId(IResolvable)
//  .fileInfo(IResolvable)
//  .fileInfo(java.util.Map<java.lang.String, java.lang.Object>)
//  .mediaMetaData(IResolvable)
//  .mediaMetaData(java.util.Map<java.lang.String, java.lang.Object>)
//  .postProcessConfig(IResolvable)
//  .postProcessConfig(java.util.Map<java.lang.String, java.lang.Object>)
//  .uploadTargetConfig(IResolvable)
//  .uploadTargetConfig(java.util.Map<java.lang.String, java.lang.Object>)
//  .userData(IResolvable)
//  .userData(java.util.Map<java.lang.String, java.lang.Object>)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

appId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property appId: The application ID.

Default value: app-1000000.

entityId^Optional

• Type: java.lang.String OR com.aliyun.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.

fileInfo^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

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.

mediaMetaData^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

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.

postProcessConfig^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

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

ProcessType Value: Workflow.

uploadTargetConfig^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

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.

userData^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property userData: The user data.

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

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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.

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.ice.UploadMedia;
UploadMedia.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrFileUrl^Required

public java.lang.Object getAttrFileUrl();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute FileURL: The OSS URL of the file.

The URL does not contain the information used for authentication.

attrMediaId^Required

public java.lang.Object getAttrMediaId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute MediaId: The ID of the media asset.

attrMediaUrl^Required

public java.lang.Object getAttrMediaUrl();

• Type: java.lang.String OR com.aliyun.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.

attrUploadAddress^Required

public java.lang.Object getAttrUploadAddress();

• Type: java.lang.String OR com.aliyun.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.

attrUploadAuth^Required

public java.lang.Object getAttrUploadAuth();

• Type: java.lang.String OR com.aliyun.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.

props^Required

public UploadMediaProps getProps();

• Type: UploadMediaProps

Structs