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 { AntiBruteForceRule } from '@alicloud/ros-cdk-threatdetection'
new AntiBruteForceRule(scope: Construct, id: string, props: AntiBruteForceRuleProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	AntiBruteForceRuleProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: AntiBruteForceRuleProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

Methods

Name	Description
toString	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition	No description.
addCount	No description.
addDependency	No description.
addResourceDesc	No description.
applyRemovalPolicy	No description.
getAtt	No description.
setMetadata	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

Static Functions

Name	Description
isConstruct	Return whether the given object is a Construct.

---

isConstruct

import { AntiBruteForceRule } from '@alicloud/ros-cdk-threatdetection'
AntiBruteForceRule.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

Name	Type	Description
node	@alicloud/ros-cdk-core.ConstructNode	The construct tree node associated with this construct.
ref	string	No description.
stack	@alicloud/ros-cdk-core.Stack	The stack in which this resource is defined.
resource	@alicloud/ros-cdk-core.RosResource	No description.
attrAntiBruteForceRuleId	@alicloud/ros-cdk-core.IResolvable	Attribute AntiBruteForceRuleId: The ID of the defense rule.
attrAntiBruteForceRuleName	@alicloud/ros-cdk-core.IResolvable	Attribute AntiBruteForceRuleName: The name of the defense rule.
attrDefaultRule	@alicloud/ros-cdk-core.IResolvable	Attribute DefaultRule: Specifies whether to set the defense rule as the default rule.
attrFailCount	@alicloud/ros-cdk-core.IResolvable	Attribute FailCount: The threshold for the number of failed user logins when the brute-force defense rule takes effect.
attrForbiddenTime	@alicloud/ros-cdk-core.IResolvable	Attribute ForbiddenTime: The period of time during which logons from an account are not allowed.
attrSpan	@alicloud/ros-cdk-core.IResolvable	Attribute Span: The period of time during which logon failures from an account are measured.
attrUuidList	@alicloud/ros-cdk-core.IResolvable	Attribute UuidList: The UUIDs of the server to which the defense rule is applied.

---

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

attrAntiBruteForceRuleId^Required

public readonly attrAntiBruteForceRuleId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute AntiBruteForceRuleId: The ID of the defense rule.

---

attrAntiBruteForceRuleName^Required

public readonly attrAntiBruteForceRuleName: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute AntiBruteForceRuleName: The name of the defense rule.

---

attrDefaultRule^Required

public readonly attrDefaultRule: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

Valid values: - true: yes - false: no

---

attrFailCount^Required

public readonly attrFailCount: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---

attrForbiddenTime^Required

public readonly attrForbiddenTime: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

Unit: minutes.

---

attrSpan^Required

public readonly attrSpan: IResolvable;

• Type: @alicloud/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.

---

attrUuidList^Required

public readonly attrUuidList: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

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

---