AntiBruteForceRule
- Implements: ros_cdk_threatdetection.datasource.IAntiBruteForceRule
This class encapsulates and extends the ROS resource type DATASOURCE::ThreatDetection::AntiBruteForceRule, which is used to query the information about a created defense rule against brute-force attacks.
Initializers
from ros_cdk_threatdetection import datasource
datasource.AntiBruteForceRule(
scope: Construct,
id: str,
anti_brute_force_rule_id: typing.Union[typing.Union[int, float], IResolvable],
refresh_options: typing.Union[str, 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_id | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property antiBruteForceRuleId: The ID of the defense rule. |
refresh_options | typing.Union[str, ros_cdk_core.IResolvable] | Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
anti_brute_force_rule_idRequired
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property antiBruteForceRuleId: The ID of the defense rule.
refresh_optionsOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
Valid values:
- Never: Never refresh the datasource resource when the stack is updated.
- Always: Always refresh the datasource resource when the stack is updated. Default is Never.
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. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | 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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- 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
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description |
|---|---|
is_construct | Return whether the given object is a Construct. |
is_construct
from ros_cdk_threatdetection import datasource
datasource.AntiBruteForceRule.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
| Name | Type | Description |
|---|---|---|
node | ros_cdk_core.ConstructNode | The construct tree node associated with this construct. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
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 | typing.Union[str, ros_cdk_core.IResolvable] | Attribute AntiBruteForceRuleId: The ID of the defense rule. |
attr_anti_brute_force_rule_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute AntiBruteForceRuleName: The name of the defense rule. |
attr_default_rule | typing.Union[str, ros_cdk_core.IResolvable] | Attribute DefaultRule: Indicates whether the defense rule is the default rule. |
attr_fail_count | typing.Union[str, ros_cdk_core.IResolvable] | Attribute FailCount: The threshold of logon failures that is specified in the defense rule. |
attr_forbidden_time | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ForbiddenTime: The period of time during which logons from an account are not allowed. |
attr_span | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Span: The period of time during which logon failures from an account are measured. |
attr_uuid_list | typing.Union[str, ros_cdk_core.IResolvable] | Attribute UuidList: An array consisting of the UUIDs of servers to which the defense rule is applied. |
props | AntiBruteForceRuleProps | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
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: 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_nameRequired
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_ruleRequired
attr_default_rule: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute DefaultRule: Indicates whether the defense rule is the default rule.
attr_fail_countRequired
attr_fail_count: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute FailCount: The threshold of logon failures that is specified in the defense rule.
attr_forbidden_timeRequired
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_spanRequired
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 address of attackers cannot be used to log on to the server in the specified period of time.
attr_uuid_listRequired
attr_uuid_list: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute UuidList: An array consisting of the UUIDs of servers to which the defense rule is applied.
propsRequired
props: AntiBruteForceRuleProps
- Type: AntiBruteForceRuleProps