Skip to content

ClientFileProtect

This class encapsulates and extends the ROS resource type ALIYUN::ThreatDetection::ClientFileProtect.

Initializers

import ros_cdk_threatdetection
ros_cdk_threatdetection.ClientFileProtect(
  scope: Construct,
  id: str,
  file_ops: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  file_paths: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  proc_paths: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  rule_action: typing.Union[str, IResolvable],
  rule_name: typing.Union[str, IResolvable],
  alert_level: typing.Union[typing.Union[int, float], IResolvable] = None,
  platform: typing.Union[str, IResolvable] = None,
  status: typing.Union[typing.Union[int, float], IResolvable] = None,
  switch_id: 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.
file_ops typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property fileOps: The operations that you want to perform on the files.
file_paths typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property filePaths: The paths to the monitored files.
proc_paths typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] Property procPaths: The paths to the monitored processes.
rule_action typing.Union[str, ros_cdk_core.IResolvable] Property ruleAction: The handling method of the rule.
rule_name typing.Union[str, ros_cdk_core.IResolvable] Property ruleName: The name of the rule.
alert_level typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property alertLevel: The severity of alerts.
platform typing.Union[str, ros_cdk_core.IResolvable] Property platform: The type of the operating system.
status typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property status: Rule status.
switch_id typing.Union[str, ros_cdk_core.IResolvable] Property switchId: The switch ID of the rule.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

file_opsRequired

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

Property fileOps: The operations that you want to perform on the files.


file_pathsRequired

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

Property filePaths: The paths to the monitored files.

Wildcard characters are supported.


proc_pathsRequired

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

Property procPaths: The paths to the monitored processes.


rule_actionRequired

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

Property ruleAction: The handling method of the rule.

Valid values:

  • pass: allow
  • alert.

rule_nameRequired

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

Property ruleName: The name of the rule.


alert_levelOptional

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

Property alertLevel: The severity of alerts.

Valid values:

  • 0: does not generate alerts
  • 1: sends notifications
  • 2: suspicious
  • 3: high-risk.

platformOptional

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

Property platform: The type of the operating system.

Valid values:

  • windows: Windows
  • linux: Linux.

statusOptional

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

Property status: Rule status.

1: Enabled 0: Not enabled


switch_idOptional

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

Property switchId: The switch ID of the rule.


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.

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

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

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_threatdetection
ros_cdk_threatdetection.ClientFileProtect.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.
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_alert_level typing.Union[str, ros_cdk_core.IResolvable] Attribute AlertLevel: The severity of alerts.
attr_file_ops typing.Union[str, ros_cdk_core.IResolvable] Attribute FileOps: The operations that you want to perform on the files.
attr_file_paths typing.Union[str, ros_cdk_core.IResolvable] Attribute FilePaths: The paths to the monitored files.
attr_platform typing.Union[str, ros_cdk_core.IResolvable] Attribute Platform: The type of the operating system.
attr_proc_paths typing.Union[str, ros_cdk_core.IResolvable] Attribute ProcPaths: The paths to the monitored processes.
attr_rule_action typing.Union[str, ros_cdk_core.IResolvable] Attribute RuleAction: The handling method of the rule.
attr_rule_id typing.Union[str, ros_cdk_core.IResolvable] Attribute RuleId: The ID of the rule.
attr_rule_name typing.Union[str, ros_cdk_core.IResolvable] Attribute RuleName: The name of the rule.
attr_switch_id typing.Union[str, ros_cdk_core.IResolvable] Attribute SwitchId: The switch ID of the rule.
props ClientFileProtectProps 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_alert_levelRequired

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

Attribute AlertLevel: The severity of alerts.


attr_file_opsRequired

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

Attribute FileOps: The operations that you want to perform on the files.


attr_file_pathsRequired

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

Attribute FilePaths: The paths to the monitored files.

Wildcard characters are supported.


attr_platformRequired

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

Attribute Platform: The type of the operating system.


attr_proc_pathsRequired

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

Attribute ProcPaths: The paths to the monitored processes.


attr_rule_actionRequired

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

Attribute RuleAction: The handling method of the rule.


attr_rule_idRequired

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

Attribute RuleId: The ID of the rule.


attr_rule_nameRequired

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

Attribute RuleName: The name of the rule.


attr_switch_idRequired

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

Attribute SwitchId: The switch ID of the rule.


propsRequired

props: ClientFileProtectProps