# API Reference
## Structs
### RuleConfig
#### Initializer
```typescript
import { RuleConfig } from '@gammarers/aws-waf-geo-restrict-rule'
const ruleConfig: RuleConfig = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| priority | number | *No description.* |
| cloudWatchMetricsName | string | *No description.* |
| ruleName | string | *No description.* |
---
##### `priority`Required
```typescript
public readonly priority: number;
```
- *Type:* number
---
##### `cloudWatchMetricsName`Optional
```typescript
public readonly cloudWatchMetricsName: string;
```
- *Type:* string
---
##### `ruleName`Optional
```typescript
public readonly ruleName: string;
```
- *Type:* string
---
### WAFGeoRestrictRuleProps
#### Initializer
```typescript
import { WAFGeoRestrictRuleProps } from '@gammarers/aws-waf-geo-restrict-rule'
const wAFGeoRestrictRuleProps: WAFGeoRestrictRuleProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| allowCountries | string[] | *No description.* |
---
##### `allowCountries`Required
```typescript
public readonly allowCountries: string[];
```
- *Type:* string[]
---
## Classes
### WAFGeoRestrictRule
#### Initializers
```typescript
import { WAFGeoRestrictRule } from '@gammarers/aws-waf-geo-restrict-rule'
new WAFGeoRestrictRule(props: WAFGeoRestrictRuleProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| props | WAFGeoRestrictRuleProps | *No description.* |
---
##### `props`Required
- *Type:* WAFGeoRestrictRuleProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| allowRule | *No description.* |
| blockRule | *No description.* |
---
##### `allowRule`
```typescript
public allowRule(config: RuleConfig): RuleProperty
```
###### `config`Required
- *Type:* RuleConfig
---
##### `blockRule`
```typescript
public blockRule(config: RuleConfig): RuleProperty
```
###### `config`Required
- *Type:* RuleConfig
---