ContainerDefenseRule

• Implements: IContainerDefenseRule

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

Initializers

import ros_cdk_threatdetection
ros_cdk_threatdetection.ContainerDefenseRule(
  scope: Construct,
  id: str,
  description: typing.Union[str, IResolvable] = None,
  rule_action: typing.Union[typing.Union[int, float], IResolvable] = None,
  rule_id: typing.Union[typing.Union[int, float], IResolvable] = None,
  rule_name: typing.Union[str, IResolvable] = None,
  rule_switch: typing.Union[typing.Union[int, float], IResolvable] = None,
  rule_type: typing.Union[typing.Union[int, float], IResolvable] = None,
  scope: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ScopeProperty]]] = None,
  whitelist: typing.Union[IResolvable, WhitelistProperty] = None,
  whitelist_hash: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

description^Optional

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

Property description: Rule description.

rule_action^Optional

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

Property ruleAction: The action that is performed when the rule is hit.

Valid values:

• 1: alert
• 2: block.

rule_id^Optional

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

Property ruleId: Rule Id.

rule_name^Optional

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

Property ruleName: The name of the rule.

rule_switch^Optional

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

Property ruleSwitch: The switch of the rule.

Valid values:

• 0: off.
• 1: on.

rule_type^Optional

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

Property ruleType: The rule type.

Value:

• 2: User Rules

scope^Optional

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

Property scope: Rule scope.

whitelist^Optional

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

Property whitelist: The whitelist of rule.

whitelist_hash^Optional

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

Property whitelistHash: The whitelist Hash.

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_threatdetection
ros_cdk_threatdetection.ContainerDefenseRule.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_description^Required

attr_description: typing.Union[str, IResolvable]

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

Attribute Description: Rule description.

attr_rule_action^Required

attr_rule_action: typing.Union[str, IResolvable]

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

Attribute RuleAction: The action that is performed when the rule is hit.

attr_rule_id^Required

attr_rule_id: typing.Union[str, IResolvable]

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

Attribute RuleId: Rule Id.

attr_rule_name^Required

attr_rule_name: typing.Union[str, IResolvable]

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

Attribute RuleName: The name of the rule.

attr_rule_switch^Required

attr_rule_switch: typing.Union[str, IResolvable]

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

Attribute RuleSwitch: The switch of the rule.

attr_rule_type^Required

attr_rule_type: typing.Union[str, IResolvable]

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

Attribute RuleType: The rule type.

attr_scope^Required

attr_scope: typing.Union[str, IResolvable]

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

Attribute Scope: Rule scope.

attr_whitelist^Required

attr_whitelist: typing.Union[str, IResolvable]

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

Attribute Whitelist: The whitelist of rule.

props^Required

props: ContainerDefenseRuleProps

• Type: ContainerDefenseRuleProps