InsertMediaToSearchLib

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

Initializers

import ros_cdk_ice
ros_cdk_ice.InsertMediaToSearchLib(
  scope: Construct,
  id: str,
  input: typing.Union[str, IResolvable],
  media_id: typing.Union[str, IResolvable] = None,
  media_type: typing.Union[str, IResolvable] = None,
  msg_body: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  search_lib_name: 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.
input	typing.Union[str, ros_cdk_core.IResolvable]	Property input: The URL of the video, audio, or image file that you want to import to the search library.
media_id	typing.Union[str, ros_cdk_core.IResolvable]	Property mediaId: The ID of the media asset.
media_type	typing.Union[str, ros_cdk_core.IResolvable]	Property mediaType: The type of the media asset.
msg_body	typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]	Property msgBody: The message body.
search_lib_name	typing.Union[str, ros_cdk_core.IResolvable]	Property searchLibName: The name of the search library.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

input^Required

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

Property input: The URL of the video, audio, or image file that you want to import to the search library.

Note: Make sure that you specify a correct file name and the bucket in which the file resides is in the same region where this operation is called. Otherwise, the file cannot be found or the operation may fail. Specify an Object Storage Service (OSS) URL in the following format: oss://[Bucket name]/[File path]. For example, you can specify oss://[example-bucket-]/[object_path-]. Specify an HTTP URL in the following format: public endpoint. For example, you can specify http://example-test-****.mp4.

---

media_id^Optional

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

Property mediaId: The ID of the media asset.

Each media ID is unique. If you leave this parameter empty, a media ID is automatically generated for this parameter.

---

media_type^Optional

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

Property mediaType: The type of the media asset.

Valid values: video (default) image audio

---

msg_body^Optional

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

Property msgBody: The message body.

---

search_lib_name^Optional

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

Property searchLibName: The name of the search library.

Default value: ims-default-search-lib.

---

enable_resource_property_constraint^Optional

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

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

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

count^Required

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

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

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

key^Required

• Type: str

---

value^Required

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

Return whether the given object is a Construct.

x^Required

• 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_media_id	ros_cdk_core.IResolvable	Attribute MediaId: The ID of the media asset.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_media_id^Required

attr_media_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute MediaId: The ID of the media asset.

---