Skip to content

AntiBruteForceRule

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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
anti_brute_force_rule_name typing.Union[str, ros_cdk_core.IResolvable] Property antiBruteForceRuleName: The name of the defense rule.
fail_count typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property failCount: The maximum number of failed logon attempts from an account.
forbidden_time 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.
span 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.
uuid_list 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 typing.Union[bool, ros_cdk_core.IResolvable] Property defaultRule: Specifies whether to set the defense rule as the default rule.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

anti_brute_force_rule_nameRequired

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

Property antiBruteForceRuleName: The name of the defense rule.

fail_countRequired

  • 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_timeRequired

  • 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

spanRequired

  • 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_listRequired

  • 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_ruleOptional

  • 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_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.
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

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.AntiBruteForceRule.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.
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_anti_brute_force_rule_id ros_cdk_core.IResolvable Attribute AntiBruteForceRuleId: The ID of the defense rule.
attr_anti_brute_force_rule_name ros_cdk_core.IResolvable Attribute AntiBruteForceRuleName: The name of the defense rule.
attr_default_rule ros_cdk_core.IResolvable Attribute DefaultRule: Specifies whether to set the defense rule as the default rule.
attr_fail_count 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 ros_cdk_core.IResolvable Attribute ForbiddenTime: The period of time during which logons from an account are not allowed.
attr_span ros_cdk_core.IResolvable Attribute Span: The period of time during which logon failures from an account are measured.
attr_uuid_list ros_cdk_core.IResolvable Attribute UuidList: The UUIDs of the server to which the defense rule is applied.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

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_anti_brute_force_rule_idRequired 

attr_anti_brute_force_rule_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AntiBruteForceRuleId: The ID of the defense rule.

attr_anti_brute_force_rule_nameRequired 

attr_anti_brute_force_rule_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AntiBruteForceRuleName: The name of the defense rule.

attr_default_ruleRequired 

attr_default_rule: IResolvable
  • Type: 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_countRequired 

attr_fail_count: IResolvable
  • Type: 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_timeRequired 

attr_forbidden_time: IResolvable
  • Type: ros_cdk_core.IResolvable

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

Unit: minutes.

attr_spanRequired 

attr_span: IResolvable
  • Type: 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_listRequired 

attr_uuid_list: IResolvable
  • Type: ros_cdk_core.IResolvable

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