API.md

API Reference

Structs

RuleConfig

Initializer

import { RuleConfig } from '@gammarers/aws-waf-ip-rate-limit-rule'

const ruleConfig: RuleConfig = { ... }

Properties

Name	Type	Description
priority	number	No description.
cloudWatchMetricsName	string	No description.
ruleName	string	No description.

---

priority^Required

public readonly priority: number;

• Type: number

---

cloudWatchMetricsName^Optional

public readonly cloudWatchMetricsName: string;

• Type: string

---

ruleName^Optional

public readonly ruleName: string;

• Type: string

---

WAFIPRateLimitRuleProps

Initializer

import { WAFIPRateLimitRuleProps } from '@gammarers/aws-waf-ip-rate-limit-rule'

const wAFIPRateLimitRuleProps: WAFIPRateLimitRuleProps = { ... }

Properties

Name	Type	Description
rateLimit	number	No description.

---

rateLimit^Required

public readonly rateLimit: number;

• Type: number

---

Classes

WAFIPRateLimitRule

Initializers

import { WAFIPRateLimitRule } from '@gammarers/aws-waf-ip-rate-limit-rule'

new WAFIPRateLimitRule(props: WAFIPRateLimitRuleProps)

Name	Type	Description
props	WAFIPRateLimitRuleProps	No description.

---

props^Required

• Type: WAFIPRateLimitRuleProps

---

Methods

Name	Description
blockRule	No description.

---

blockRule

public blockRule(config: RuleConfig): RuleProperty

config^Required

• Type: RuleConfig

---