OssStockTask

• Implements: IOssStockTask

This class encapsulates and extends the ROS resource type ALIYUN::Aligreen::OssStockTask, which is used to create a full scan task for Object Storage Service (OSS) buckets.

Initializers

import ros_cdk_aligreen
ros_cdk_aligreen.OssStockTask(
  scope: Construct,
  id: str,
  buckets: typing.Union[typing.List[typing.Any], IResolvable],
  start_date: typing.Union[str, IResolvable],
  audio_antispam_freeze_config: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  audio_auto_freeze_opened: typing.Union[bool, IResolvable] = None,
  audio_max_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  audio_opened: typing.Union[bool, IResolvable] = None,
  audio_scan_limit: typing.Union[typing.Union[int, float], IResolvable] = None,
  audio_scenes: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  auto_freeze_type: typing.Union[str, IResolvable] = None,
  biz_type: typing.Union[str, IResolvable] = None,
  callback_id: typing.Union[typing.Union[int, float], IResolvable] = None,
  end_date: typing.Union[str, IResolvable] = None,
  image_ad_freeze_config: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  image_auto_freeze_opened: typing.Union[bool, IResolvable] = None,
  image_live_freeze_config: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  image_opened: typing.Union[bool, IResolvable] = None,
  image_porn_freeze_config: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  image_scan_limit: typing.Union[typing.Union[int, float], IResolvable] = None,
  image_scenes: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  image_terrorism_freeze_config: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  oss_stock_task_name: typing.Union[str, IResolvable] = None,
  scan_image_no_file_type: typing.Union[bool, IResolvable] = None,
  video_ad_freeze_config: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  video_auto_freeze_opened: typing.Union[bool, IResolvable] = None,
  video_frame_interval: typing.Union[typing.Union[int, float], IResolvable] = None,
  video_live_freeze_config: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  video_max_frames: typing.Union[typing.Union[int, float], IResolvable] = None,
  video_max_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  video_opened: typing.Union[bool, IResolvable] = None,
  video_porn_freeze_config: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  video_scan_limit: typing.Union[typing.Union[int, float], IResolvable] = None,
  video_scenes: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  video_terrorism_freeze_config: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  video_voice_antispam_freeze_config: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

buckets^Required

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

Property buckets: The bucket configuration list of the oss stock scan task.

Example:[{"Bucket":"bucket_01","Selected":true,"Prefixes":["img/test_"],"Type":"exclude"}].

start_date^Required

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

Property startDate: The start time of the file upload time range represents the files uploaded after scanning this time point.Example: 2024-08-01 00:00:00 +0800.

audio_antispam_freeze_config^Optional

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

Property audioAntispamFreezeConfig: Voice auto freeze configuration.

Example:{"Type": "suggestion", "Value" : "block" }. The results are frozen according to the suggestion in the speech detection results.

audio_auto_freeze_opened^Optional

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

Property audioAutoFreezeOpened: Audio detection auto freeze switch.

Value: true: automatically freeze, false: not automatically freeze.

audio_max_size^Optional

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

Property audioMaxSize: Resource property field representing the maximum size of a single audio.

1~2048MB, the default is 200MB, more than not detected.

audio_opened^Optional

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

Property audioOpened: Oss stock scan task detect audio.

true: scan audio, false: do not scan audio.

audio_scan_limit^Optional

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

Property audioScanLimit: The upper limit of voice scan in the oss stock scan task.

The default value is 1000/Bucket.

audio_scenes^Optional

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

Property audioScenes: The audio detection scenarios included in the oss stock scan task.

Set the value to ["antispam"].

auto_freeze_type^Optional

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

Property autoFreezeType: Automatic freeze type.

Value: acl: modify permissions, copy: Move files.

biz_type^Optional

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

Property bizType: Business scenarios used by the oss stock scan task.

callback_id^Optional

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

Property callbackId: The ID of the primary key of the notification message bound to the oss stock scan task.

end_date^Optional

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

Property endDate: The end time of the file upload time range indicates the scanning of files uploaded before this time point.

Example: 2024-12-30 00:00:00 +0800

image_ad_freeze_config^Optional

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

Property imageAdFreezeConfig: Picture automatically freezes the configuration of ad scenes.

Example: {"Type": "suggestion", "Value": "block,review"}. The result will be frozen according to the suggestion in the picture detection result.

image_auto_freeze_opened^Optional

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

Property imageAutoFreezeOpened: Picture detection auto freeze switch.

Value: true: auto freeze, false: not auto freeze.

image_live_freeze_config^Optional

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

Property imageLiveFreezeConfig: Picture automatic freezing live scene configuration.

Example:{"Type":"suggestion","Value":"block,review"}. The result will be frozen according to the suggestion in the picture detection result.

image_opened^Optional

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

Property imageOpened: Oss stock scan task detect images.

true: scan images, false: do not scan images.

image_porn_freeze_config^Optional

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

Property imagePornFreezeConfig: Picture automatic freezing porn scene configuration.

Example: {"Type": "suggestion", "Value": "block,review"}. The result will be frozen according to the suggestion in the picture detection result.

image_scan_limit^Optional

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

Property imageScanLimit: The upper limit for scanning images in the oss stock scan task.

The default value is 10000 images per Bucket.

image_scenes^Optional

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

Property imageScenes: The image moderation scenario included in the oss stock scan task.Valid values: porn: pornography detection terrorism: terrorist content detection ad: ad violation detection live: undesirable scene detection.

image_terrorism_freeze_config^Optional

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

Property imageTerrorismFreezeConfig: The picture automatically freezes the configuration of terrorism scenes.

Example: {"Type": "suggestion", "Value": "block,review"}. The result will be frozen according to the suggestion in the picture detection result.

oss_stock_task_name^Optional

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

Property ossStockTaskName: The name of the oss stock scan task.

scan_image_no_file_type^Optional

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

Property scanImageNoFileType: Whether the oss stock scan task detects images with file names without suffixes.

true: Detect pictures with file names without suffixes, false: Do not detect pictures with file names without suffixes.

video_ad_freeze_config^Optional

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

Property videoAdFreezeConfig: The video automatically freezes the configuration of ad scenarios.

Example:{"Type":"suggestion","Value":"block,review"}. The results will be frozen according to the suggestion in the video detection results.

video_auto_freeze_opened^Optional

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

Property videoAutoFreezeOpened: Video detection auto freeze switch.

Value: true: automatically freeze, false: not automatically freeze.

video_frame_interval^Optional

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

Property videoFrameInterval: Resource attribute field representing the framing frequency.

1~60 seconds/frame, the default is 1 second/frame.

video_live_freeze_config^Optional

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

Property videoLiveFreezeConfig: Video automatic freeze live scene configuration.

Example:{"Type" : "suggestion", "Value" : "block" }. The results will be frozen according to the suggestion in the video detection results.

video_max_frames^Optional

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

Property videoMaxFrames: A resource attribute field that represents the upper limit of a single video frame cut.

5 to 20000 frames, the default is 200 frames.

video_max_size^Optional

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

Property videoMaxSize: Resource property field representing the maximum size of a single video.

1~2048MB, the default is 500MB, more than not detected.

video_opened^Optional

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

Property videoOpened: Oss stock scan task detect video.

true: scan video, false: do not scan video.

video_porn_freeze_config^Optional

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

Property videoPornFreezeConfig: Video automatic freezing porn scene configuration.

Example: {"Type": "suggestion", "Value": "block,review"}. The result will be frozen according to the suggestion in the video detection result.

video_scan_limit^Optional

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

Property videoScanLimit: The upper limit of video scanning in the oss stock scan task.

The default value is 1000/Bucket.

video_scenes^Optional

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

Property videoScenes: The video detection scenarios included in the oss stock scan task.

porn: pornography detection terrorism: terrorist content detection ad: ad violation detection live: undesirable scene detection antispam: Video voice antispam.

video_terrorism_freeze_config^Optional

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

Property videoTerrorismFreezeConfig: The video automatically freezes the configuration of terrorism scenes.

Example:{"Type": "suggestion","Value":"block,review"}. The results will be frozen according to the suggestion in the video detection results.

video_voice_antispam_freeze_config^Optional

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

Property videoVoiceAntispamFreezeConfig: Voice auto freeze configuration in video.

Example:{"Type": "suggestion", "Value" : "block" }. The results will be frozen according to the suggestion in the video detection results.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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

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

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

is_construct

import ros_cdk_aligreen
ros_cdk_aligreen.OssStockTask.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

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.

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_audio_antispam_freeze_config^Required

attr_audio_antispam_freeze_config: typing.Union[str, IResolvable]

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

Attribute AudioAntispamFreezeConfig: Voice auto freeze configuration.

attr_audio_auto_freeze_opened^Required

attr_audio_auto_freeze_opened: typing.Union[str, IResolvable]

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

Attribute AudioAutoFreezeOpened: Audio detection auto freeze switch.

Value: true: automatically freeze, false: not automatically freeze.

attr_audio_max_size^Required

attr_audio_max_size: typing.Union[str, IResolvable]

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

Attribute AudioMaxSize: Resource property field representing the maximum size of a single audio.

attr_audio_opened^Required

attr_audio_opened: typing.Union[str, IResolvable]

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

Attribute AudioOpened: oss stock scan task detect audio.

attr_audio_scan_limit^Required

attr_audio_scan_limit: typing.Union[str, IResolvable]

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

Attribute AudioScanLimit: The upper limit of voice scan in the oss stock scan task.

The default value is 1000/Bucket.

attr_audio_scenes^Required

attr_audio_scenes: typing.Union[str, IResolvable]

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

Attribute AudioScenes: The audio detection scenarios included in the oss stock scan task.

Set the value to antispam.

attr_auto_freeze_type^Required

attr_auto_freeze_type: typing.Union[str, IResolvable]

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

Attribute AutoFreezeType: Automatic freeze type.

attr_biz_type^Required

attr_biz_type: typing.Union[str, IResolvable]

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

Attribute BizType: Business scenarios used by the oss stock scan task.

attr_buckets^Required

attr_buckets: typing.Union[str, IResolvable]

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

Attribute Buckets: The bucket configuration list of the oss stock scan task.

attr_callback_id^Required

attr_callback_id: typing.Union[str, IResolvable]

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

Attribute CallbackId: The ID of the primary key of the notification message bound to the oss stock scan task.

attr_end_date^Required

attr_end_date: typing.Union[str, IResolvable]

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

Attribute EndDate: The end time of the file upload time range indicates the scanning of files uploaded before this time point.

attr_image_ad_freeze_config^Required

attr_image_ad_freeze_config: typing.Union[str, IResolvable]

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

Attribute ImageAdFreezeConfig: Picture automatically freezes the configuration of ad scenes.

attr_image_auto_freeze_opened^Required

attr_image_auto_freeze_opened: typing.Union[str, IResolvable]

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

Attribute ImageAutoFreezeOpened: Picture detection auto freeze switch.

Value: true: auto freeze, false: not auto freeze.

attr_image_live_freeze_config^Required

attr_image_live_freeze_config: typing.Union[str, IResolvable]

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

Attribute ImageLiveFreezeConfig: Picture automatic freezing live scene configuration.

attr_image_opened^Required

attr_image_opened: typing.Union[str, IResolvable]

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

Attribute ImageOpened: oss stock scan task detect images.

attr_image_porn_freeze_config^Required

attr_image_porn_freeze_config: typing.Union[str, IResolvable]

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

Attribute ImagePornFreezeConfig: Picture automatic freezing porn scene configuration.

attr_image_scan_limit^Required

attr_image_scan_limit: typing.Union[str, IResolvable]

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

Attribute ImageScanLimit: The upper limit for scanning images in the oss stock scan task.

attr_image_scenes^Required

attr_image_scenes: typing.Union[str, IResolvable]

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

Attribute ImageScenes: The image moderation scenario included in the oss stock scan task.

attr_image_terrorism_freeze_config^Required

attr_image_terrorism_freeze_config: typing.Union[str, IResolvable]

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

Attribute ImageTerrorismFreezeConfig: The picture automatically freezes the configuration of terrorism scenes.

attr_scan_image_no_file_type^Required

attr_scan_image_no_file_type: typing.Union[str, IResolvable]

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

Attribute ScanImageNoFileType: Whether the oss stock scan task detects images with file names without suffixes.

attr_start_date^Required

attr_start_date: typing.Union[str, IResolvable]

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

Attribute StartDate: The start time of the file upload time range represents the files uploaded after scanning this time point.

attr_video_ad_freeze_config^Required

attr_video_ad_freeze_config: typing.Union[str, IResolvable]

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

Attribute VideoAdFreezeConfig: The video automatically freezes the configuration of ad scenarios.

attr_video_auto_freeze_opened^Required

attr_video_auto_freeze_opened: typing.Union[str, IResolvable]

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

Attribute VideoAutoFreezeOpened: Video detection auto freeze switch.

Value: true: automatically freeze, false: not automatically freeze.

attr_video_frame_interval^Required

attr_video_frame_interval: typing.Union[str, IResolvable]

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

Attribute VideoFrameInterval: Resource attribute field representing the framing frequency.

attr_video_live_freeze_config^Required

attr_video_live_freeze_config: typing.Union[str, IResolvable]

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

Attribute VideoLiveFreezeConfig: Video automatic freeze live scene configuration.

attr_video_max_frames^Required

attr_video_max_frames: typing.Union[str, IResolvable]

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

Attribute VideoMaxFrames: A resource attribute field that represents the upper limit of a single video frame cut.

attr_video_max_size^Required

attr_video_max_size: typing.Union[str, IResolvable]

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

Attribute VideoMaxSize: Resource property field representing the maximum size of a single video.

attr_video_opened^Required

attr_video_opened: typing.Union[str, IResolvable]

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

Attribute VideoOpened: oss stock scan task detect video.

attr_video_porn_freeze_config^Required

attr_video_porn_freeze_config: typing.Union[str, IResolvable]

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

Attribute VideoPornFreezeConfig: Video automatic freezing porn scene configuration.

attr_video_scan_limit^Required

attr_video_scan_limit: typing.Union[str, IResolvable]

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

Attribute VideoScanLimit: The upper limit of video scanning in the oss stock scan task.

The default value is 1000/Bucket.

attr_video_scenes^Required

attr_video_scenes: typing.Union[str, IResolvable]

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

Attribute VideoScenes: The video detection scenarios included in the oss stock scan task.

attr_video_terrorism_freeze_config^Required

attr_video_terrorism_freeze_config: typing.Union[str, IResolvable]

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

Attribute VideoTerrorismFreezeConfig: The video automatically freezes the configuration of terrorism scenes.

attr_video_voice_antispam_freeze_config^Required

attr_video_voice_antispam_freeze_config: typing.Union[str, IResolvable]

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

Attribute VideoVoiceAntispamFreezeConfig: Voice auto freeze configuration in video.

props^Required

props: OssStockTaskProps

• Type: OssStockTaskProps