# API Reference
## Constructs
### EventBridgeSchedule
#### Initializers
```typescript
import { EventBridgeSchedule } from 'awscdk-construct-scte-scheduler'
new EventBridgeSchedule(scope: Construct, id: string, props: EventBridgeScheduleProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | EventBridgeScheduleProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* EventBridgeScheduleProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { EventBridgeSchedule } from 'awscdk-construct-scte-scheduler'
EventBridgeSchedule.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| rule | aws-cdk-lib.aws_events.Rule | *No description.* |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `rule`Required
```typescript
public readonly rule: Rule;
```
- *Type:* aws-cdk-lib.aws_events.Rule
---
### Lambda
#### Initializers
```typescript
import { Lambda } from 'awscdk-construct-scte-scheduler'
new Lambda(scope: Construct, id: string, props: LambdaProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | LambdaProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* LambdaProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { Lambda } from 'awscdk-construct-scte-scheduler'
Lambda.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| func | aws-cdk-lib.aws_lambda_nodejs.NodejsFunction | *No description.* |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `func`Required
```typescript
public readonly func: NodejsFunction;
```
- *Type:* aws-cdk-lib.aws_lambda_nodejs.NodejsFunction
---
### ScteScheduler
#### Initializers
```typescript
import { ScteScheduler } from 'awscdk-construct-scte-scheduler'
new ScteScheduler(scope: Construct, id: string, props: ScteSchedulerProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | ScteSchedulerProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* ScteSchedulerProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { ScteScheduler } from 'awscdk-construct-scte-scheduler'
ScteScheduler.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| lambda | Lambda | *No description.* |
| schedule | EventBridgeSchedule | *No description.* |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `lambda`Required
```typescript
public readonly lambda: Lambda;
```
- *Type:* Lambda
---
##### `schedule`Optional
```typescript
public readonly schedule: EventBridgeSchedule;
```
- *Type:* EventBridgeSchedule
---
## Structs
### EventBridgeScheduleProps
#### Initializer
```typescript
import { EventBridgeScheduleProps } from 'awscdk-construct-scte-scheduler'
const eventBridgeScheduleProps: EventBridgeScheduleProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| schedule | aws-cdk-lib.aws_events.Schedule | *No description.* |
| target | aws-cdk-lib.aws_lambda_nodejs.NodejsFunction \| aws-cdk-lib.aws_stepfunctions.StateMachine | *No description.* |
---
##### `schedule`Required
```typescript
public readonly schedule: Schedule;
```
- *Type:* aws-cdk-lib.aws_events.Schedule
---
##### `target`Required
```typescript
public readonly target: NodejsFunction | StateMachine;
```
- *Type:* aws-cdk-lib.aws_lambda_nodejs.NodejsFunction | aws-cdk-lib.aws_stepfunctions.StateMachine
---
### LambdaProps
#### Initializer
```typescript
import { LambdaProps } from 'awscdk-construct-scte-scheduler'
const lambdaProps: LambdaProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| channelId | string | *No description.* |
| scteDurationInSeconds | number | *No description.* |
---
##### `channelId`Required
```typescript
public readonly channelId: string;
```
- *Type:* string
---
##### `scteDurationInSeconds`Required
```typescript
public readonly scteDurationInSeconds: number;
```
- *Type:* number
---
### ScteSchedulerProps
#### Initializer
```typescript
import { ScteSchedulerProps } from 'awscdk-construct-scte-scheduler'
const scteSchedulerProps: ScteSchedulerProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| channelId | string | *No description.* |
| intervalInMinutes | number | *No description.* |
| scteDurationInSeconds | number | *No description.* |
| callback | aws-cdk-lib.aws_lambda.IFunction | *No description.* |
| cronOptions | aws-cdk-lib.aws_events.CronOptions | *No description.* |
| repeatCount | number | *No description.* |
---
##### `channelId`Required
```typescript
public readonly channelId: string;
```
- *Type:* string
---
##### `intervalInMinutes`Required
```typescript
public readonly intervalInMinutes: number;
```
- *Type:* number
---
##### `scteDurationInSeconds`Required
```typescript
public readonly scteDurationInSeconds: number;
```
- *Type:* number
---
##### `callback`Optional
```typescript
public readonly callback: IFunction;
```
- *Type:* aws-cdk-lib.aws_lambda.IFunction
---
##### `cronOptions`Optional
```typescript
public readonly cronOptions: CronOptions;
```
- *Type:* aws-cdk-lib.aws_events.CronOptions
---
##### `repeatCount`Optional
```typescript
public readonly repeatCount: number;
```
- *Type:* number
---