# API Reference
## Constructs
### Pinger
#### Initializers
```typescript
import { Pinger } from 'cdk-http-pinger'
new Pinger(scope: Construct, id: string, props: PingerProps)
```
##### `scope`Required
- *Type:* [`constructs.Construct`](#constructs.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-http-pinger.PingerProps`](#cdk-http-pinger.PingerProps)
---
#### Properties
##### `body`Required
```typescript
public readonly body: string;
```
- *Type:* `string`
---
##### `htmlTitle`Required
```typescript
public readonly htmlTitle: string;
```
- *Type:* `string`
---
##### `httpStatus`Required
```typescript
public readonly httpStatus: string;
```
- *Type:* `string`
---
##### `resource`Required
```typescript
public readonly resource: CustomResource;
```
- *Type:* [`aws-cdk-lib.CustomResource`](#aws-cdk-lib.CustomResource)
---
##### `url`Required
```typescript
public readonly url: string;
```
- *Type:* `string`
---
## Structs
### PingerProps
#### Initializer
```typescript
import { PingerProps } from 'cdk-http-pinger'
const pingerProps: PingerProps = { ... }
```
##### `url`Required
```typescript
public readonly url: string;
```
- *Type:* `string`
---
##### `data`Optional
```typescript
public readonly data: {[ key: string ]: string};
```
- *Type:* {[ key: string ]: `string`}
- *Default:* no http data used
HTTP DATA.
---
##### `method`Optional
```typescript
public readonly method: HttpMethod;
```
- *Type:* [`cdk-http-pinger.HttpMethod`](#cdk-http-pinger.HttpMethod)
- *Default:* HttpMethod.GET
The HTTP Method.
---
##### `timeout`Optional
```typescript
public readonly timeout: Duration;
```
- *Type:* [`aws-cdk-lib.Duration`](#aws-cdk-lib.Duration)
- *Default:* 1 minutes
Timeout.
---
## Enums
### HttpMethod
#### `GET`
---
#### `PUT`
---
#### `POST`
---