# API Reference
## Constructs
### FsxLifecycleStatusMonitor
#### Initializers
```typescript
import { FsxLifecycleStatusMonitor } from 'aws-fsx-lifecycle-status-monitor'
new FsxLifecycleStatusMonitor(scope: Construct, id: string, props: FsxLifecycleStatusMonitorProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | - parent construct. |
| id | string | - unique id. |
| props | FsxLifecycleStatusMonitorProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
parent construct.
---
##### `id`Required
- *Type:* string
unique id.
---
##### `props`Required
- *Type:* FsxLifecycleStatusMonitorProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| createIamPolicy | *No description.* |
| createLambdaFunction | *No description.* |
| createSNSTopic | Topic linked to the Lambda function. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `createIamPolicy`
```typescript
public createIamPolicy(): Policy
```
##### `createLambdaFunction`
```typescript
public createLambdaFunction(): Function
```
##### `createSNSTopic`
```typescript
public createSNSTopic(): Topic
```
Topic linked to the Lambda function.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### ~~`isConstruct`~~
```typescript
import { FsxLifecycleStatusMonitor } from 'aws-fsx-lifecycle-status-monitor'
FsxLifecycleStatusMonitor.isConstruct(x: any)
```
Checks if `x` is a construct.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| fn | aws-cdk-lib.aws_lambda.Function | The Lambda function that will be triggered by the CloudWatch event. |
| logGroup | aws-cdk-lib.aws_logs.LogGroup | Log group for the Lambda function. |
| policy | aws-cdk-lib.aws_iam.Policy | The IAM policy that will be attached to the Lambda function. |
| rule | aws-cdk-lib.aws_events.Rule | The CloudWatch event rule that will trigger the Lambda function. |
| topic | aws-cdk-lib.aws_sns.Topic | Topic linked to the Lambda function. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `fn`Required
```typescript
public readonly fn: Function;
```
- *Type:* aws-cdk-lib.aws_lambda.Function
The Lambda function that will be triggered by the CloudWatch event.
---
##### `logGroup`Required
```typescript
public readonly logGroup: LogGroup;
```
- *Type:* aws-cdk-lib.aws_logs.LogGroup
Log group for the Lambda function.
---
##### `policy`Required
```typescript
public readonly policy: Policy;
```
- *Type:* aws-cdk-lib.aws_iam.Policy
The IAM policy that will be attached to the Lambda function.
---
##### `rule`Required
```typescript
public readonly rule: Rule;
```
- *Type:* aws-cdk-lib.aws_events.Rule
The CloudWatch event rule that will trigger the Lambda function.
---
##### `topic`Required
```typescript
public readonly topic: Topic;
```
- *Type:* aws-cdk-lib.aws_sns.Topic
Topic linked to the Lambda function.
---
#### Constants
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| DEFAULT_LOG_RETENTION_PERIOD | aws-cdk-lib.aws_logs.RetentionDays | Default log retention for the FSx Lifecycle Status Monitor. |
| DEFAULT_SCHEDULE | aws-cdk-lib.aws_events.Schedule | Default schedule for the FSx Lifecycle Status Monitor. |
---
##### `DEFAULT_LOG_RETENTION_PERIOD`Required
```typescript
public readonly DEFAULT_LOG_RETENTION_PERIOD: RetentionDays;
```
- *Type:* aws-cdk-lib.aws_logs.RetentionDays
Default log retention for the FSx Lifecycle Status Monitor.
---
##### `DEFAULT_SCHEDULE`Required
```typescript
public readonly DEFAULT_SCHEDULE: Schedule;
```
- *Type:* aws-cdk-lib.aws_events.Schedule
Default schedule for the FSx Lifecycle Status Monitor.
---
## Structs
### FsxLifecycleStatusMonitorProps
Configuration properties for the FSx Lifecycle Status Monitor.
#### Initializer
```typescript
import { FsxLifecycleStatusMonitorProps } from 'aws-fsx-lifecycle-status-monitor'
const fsxLifecycleStatusMonitorProps: FsxLifecycleStatusMonitorProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| logRetentionDays | aws-cdk-lib.aws_logs.RetentionDays | The log retention days for the FSx Lifecycle Status Monitor. |
| schedule | aws-cdk-lib.aws_events.Schedule | The schedule for the FSx Lifecycle Status Monitor. |
---
##### `logRetentionDays`Optional
```typescript
public readonly logRetentionDays: RetentionDays;
```
- *Type:* aws-cdk-lib.aws_logs.RetentionDays
- *Default:* logs.RetentionDays.ONE_YEAR
The log retention days for the FSx Lifecycle Status Monitor.
---
*Example*
```typescript
this.monitor = new FsxLifecycleStatusMonitor(this, "monitor",{
logRetentionDays: logs.RetentionDays.ONE_MONTH
});
```
##### `schedule`Optional
```typescript
public readonly schedule: Schedule;
```
- *Type:* aws-cdk-lib.aws_events.Schedule
- *Default:* "events.Schedule.cron({ minute: '0/10', hour: '*', day: '*', month: '*', year: '*' })"
The schedule for the FSx Lifecycle Status Monitor.
---
*Example*
```typescript
this.monitor = new FsxLifecycleStatusMonitor(this, "monitor",{
logRetentionDays: logs.RetentionDays.ONE_MONTH,
schedule: events.Schedule.rate(cdk.Duration.hours(1)),
});
```