ImageLib
- Implements: IImageLib
This class encapsulates and extends the ROS resource type ALIYUN::Aligreen::ImageLib, which is used to create a custom image library.
Initializers
import ros_cdk_aligreen
ros_cdk_aligreen.ImageLib(
scope: Construct,
id: str,
category: typing.Union[str, IResolvable],
image_lib_name: typing.Union[str, IResolvable],
scene: typing.Union[str, IResolvable],
biz_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
enable: typing.Union[bool, IResolvable] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
category | typing.Union[str, ros_cdk_core.IResolvable] | Property category: The category of the image library. |
image_lib_name | typing.Union[str, ros_cdk_core.IResolvable] | Property imageLibName: The name of the image library defined by the customer. |
scene | typing.Union[str, ros_cdk_core.IResolvable] | Property scene: The moderation scenario to which the custom image library applies. |
biz_types | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] | Property bizTypes: List of business scenarios. |
enable | typing.Union[bool, ros_cdk_core.IResolvable] | Property enable: Specifies whether to enable the image library. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
categoryRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property category: The category of the image library.
Valid values: BLACK: a blacklist, WHITE: a whitelist, REVIEW: a review list.
image_lib_nameRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property imageLibName: The name of the image library defined by the customer.
It can contain no more than 20 characters in Chinese, English, and underscore (_).
sceneRequired
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property scene: The moderation scenario to which the custom image library applies.
Valid values: PORN: pornography detection, AD: ad detection, ILLEGAL: terrorist content detection.
biz_typesOptional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
Property bizTypes: List of business scenarios.
For example: ["bizTypeA", "bizTypeB", "bizTypeC"].
enableOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property enable: Specifies whether to enable the image library.
Valid values: true: Enable the image library. This is the default value. false: Disable the image library.
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. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | 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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
fetch_condition
def fetch_condition() -> RosCondition
fetch_dependency
def fetch_dependency() -> typing.List[str]
fetch_resource_desc
def fetch_resource_desc() -> str
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description |
|---|---|
is_construct | Return whether the given object is a Construct. |
is_construct
import ros_cdk_aligreen
ros_cdk_aligreen.ImageLib.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
| Name | Type | Description |
|---|---|---|
node | ros_cdk_core.ConstructNode | The construct tree node associated with this construct. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
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_biz_types | typing.Union[str, ros_cdk_core.IResolvable] | Attribute BizTypes: List of business scenarios. |
attr_category | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Category: The category of the image library. |
attr_enable | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Enable: Specifies whether to enable the image library. |
attr_image_lib_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ImageLibId: The ID of the primary key of the image library. |
attr_image_lib_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ImageLibName: The name of the image library defined by the customer. |
attr_scene | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Scene: The moderation scenario to which the custom image library applies. |
props | ImageLibProps | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
env: IResourceEnvironment
- Type: 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.
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_biz_typesRequired
attr_biz_types: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute BizTypes: List of business scenarios.
attr_categoryRequired
attr_category: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Category: The category of the image library.
attr_enableRequired
attr_enable: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Enable: Specifies whether to enable the image library.
attr_image_lib_idRequired
attr_image_lib_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ImageLibId: The ID of the primary key of the image library.
attr_image_lib_nameRequired
attr_image_lib_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ImageLibName: The name of the image library defined by the customer.
attr_sceneRequired
attr_scene: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Scene: The moderation scenario to which the custom image library applies.
propsRequired
props: ImageLibProps
- Type: ImageLibProps