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 com.aliyun.ros.cdk.threatdetection.AntiBruteForceRule;
AntiBruteForceRule.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .antiBruteForceRuleName(java.lang.String)
    .antiBruteForceRuleName(IResolvable)
    .failCount(java.lang.Number)
    .failCount(IResolvable)
    .forbiddenTime(java.lang.Number)
    .forbiddenTime(IResolvable)
    .span(java.lang.Number)
    .span(IResolvable)
    .uuidList(IResolvable)
    .uuidList(java.util.List<java.lang.String)
    .uuidList(IResolvable>)
//  .defaultRule(java.lang.Boolean)
//  .defaultRule(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
antiBruteForceRuleName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property antiBruteForceRuleName: The name of the defense rule.
failCount java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property failCount: The maximum number of failed logon attempts from an account.
forbiddenTime java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property forbiddenTime: The period of time during which logons from an account are not allowed.
span java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property span: The maximum period of time during which failed logon attempts from an account can occur.
uuidList com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property uuidList: The UUIDs of the servers to which you want to apply the defense rule.
defaultRule java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property defaultRule: Specifies whether to set the defense rule as the default rule.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

antiBruteForceRuleNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property antiBruteForceRuleName: The name of the defense rule.

failCountRequired

  • Type: java.lang.Number OR com.aliyun.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.

forbiddenTimeRequired

  • Type: java.lang.Number OR com.aliyun.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: java.lang.Number OR com.aliyun.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

uuidListRequired

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

defaultRuleOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values:

  • true: yes
  • false: no

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 java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

import com.aliyun.ros.cdk.threatdetection.AntiBruteForceRule;
AntiBruteForceRule.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

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

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAntiBruteForceRuleIdRequired 

public IResolvable getAttrAntiBruteForceRuleId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AntiBruteForceRuleId: The ID of the defense rule.

attrAntiBruteForceRuleNameRequired 

public IResolvable getAttrAntiBruteForceRuleName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AntiBruteForceRuleName: The name of the defense rule.

attrDefaultRuleRequired 

public IResolvable getAttrDefaultRule();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

Valid values:

  • true: yes
  • false: no

attrFailCountRequired 

public IResolvable getAttrFailCount();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrForbiddenTimeRequired 

public IResolvable getAttrForbiddenTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

Unit: minutes.

attrSpanRequired 

public IResolvable getAttrSpan();
  • Type: com.aliyun.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.

attrUuidListRequired 

public IResolvable getAttrUuidList();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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