AntiBruteForceRule

• Implements: IAntiBruteForceRule

This class encapsulates and extends the ROS resource type ALIYUN::ThreatDetection::AntiBruteForceRule, which is used to create a defense rule against brute-force attacks.

Initializers

import ros_cdk_threatdetection
ros_cdk_threatdetection.AntiBruteForceRule(
  scope: Construct,
  id: str,
  anti_brute_force_rule_name: typing.Union[str, IResolvable],
  fail_count: typing.Union[typing.Union[int, float], IResolvable],
  forbidden_time: typing.Union[typing.Union[int, float], IResolvable],
  span: typing.Union[typing.Union[int, float], IResolvable],
  uuid_list: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  default_rule: typing.Union[bool, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

anti_brute_force_rule_name^Required

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

Property antiBruteForceRuleName: The name of the defense rule.

fail_count^Required

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

Property failCount: The maximum number of failed logon attempts from an account.

Valid values: 2, 3, 4, 5, 10, 50, 80, and 100.

forbidden_time^Required

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

Property forbiddenTime: The period of time during which logons from an account are not allowed.

Unit: minutes. Valid values:

• 5: 5 minutes
• 15: 15 minutes
• 30: 30 minutes
• 60: 1 hour
• 120: 2 hours
• 360: 6 hours
• 720: 12 hours
• 1440: 24 hours
• 10080: 7 days
• 52560000: permanent

span^Required

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

Property span: The maximum period of time during which failed logon attempts from an account can occur.

Unit: minutes. Valid values:

• 1
• 2
• 5
• 10
• 15

uuid_list^Required

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

Property uuidList: The UUIDs of the servers to which you want to apply the defense rule.

default_rule^Optional

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

Property defaultRule: Specifies whether to set the defense rule as the default rule.

Valid values:

• true: yes
• false: no

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.AntiBruteForceRule.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_anti_brute_force_rule_id^Required

attr_anti_brute_force_rule_id: typing.Union[str, IResolvable]

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

Attribute AntiBruteForceRuleId: The ID of the defense rule.

attr_anti_brute_force_rule_name^Required

attr_anti_brute_force_rule_name: typing.Union[str, IResolvable]

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

Attribute AntiBruteForceRuleName: The name of the defense rule.

attr_default_rule^Required

attr_default_rule: typing.Union[str, IResolvable]

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

Attribute DefaultRule: Specifies whether to set the defense rule as the default rule.

Valid values:

• true: yes
• false: no

attr_fail_count^Required

attr_fail_count: typing.Union[str, IResolvable]

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

Attribute FailCount: The threshold for the number of failed user logins when the brute-force defense rule takes effect.

attr_forbidden_time^Required

attr_forbidden_time: typing.Union[str, IResolvable]

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

Attribute ForbiddenTime: The period of time during which logons from an account are not allowed.

Unit: minutes.

attr_span^Required

attr_span: typing.Union[str, IResolvable]

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

Attribute Span: The period of time during which logon failures from an account are measured.

Unit: minutes. If Span is set to 10, the defense rule takes effect when the logon failures measured within 10 minutes reaches the specified threshold. The IP addresses of attackers cannot be used to log on to the server within the specified period of time.

attr_uuid_list^Required

attr_uuid_list: typing.Union[str, IResolvable]

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

Attribute UuidList: The UUIDs of the server to which the defense rule is applied.

props^Required

props: AntiBruteForceRuleProps

• Type: AntiBruteForceRuleProps